エポスかんたん決済 API一覧

HTTP仕様（.idPass）

HTTP仕様（.json）

Request header		Content-Type: application/x-www-form-urlencoded;charset=windows-31j
Method		POST
Response header		Content-Type: text/plain;charset=windows-31j
Status Code		200：常に200を返却

Request header		Content-Type: application/json;charset=UTF-8
Method		POST
Response header		Content-Type: application/json;charset=UTF-8
Status Code		200：正常時 400：入力パラメータエラー、加盟店設定エラー 500：システムエラー 502：決済エラー　　　　　　　 ※以下のエラーコードはhttp200で返却される可能性がございます。　・E90010001 　・E92000001 　・E92000002 　・E91099996 　・E91099997

EntryTranEpospay 取引登録

これ以降の決済取引で必要となる取引IDと取引パスワードの発行を行い、取引を開始します。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
OrderID	orderID	必須半角英数記号27桁オーダーID 加盟店様が取引を識別するための値を設定します。
JobCd	jobCd	必須半角英字7桁処理区分 AUTH：仮売上
Amount	amount	必須半角数字7桁利用金額税送料を指定した場合は、利用金額 + 税送料が決済金額となります。
Tax	tax	半角数字7桁税送料

URL

/payment/EntryTranEpospay.json

リクエストパラメータ

{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "orderID": "ORDER0000001",
  "jobCd": "AUTH",
  "amount": "1000"
}

URL

/payment/EntryTranEpospay.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&JobCd=AUTH&Amount=1000

レスポンス

正常

AccessID		accessID		必須半角英数32桁固定取引ID 発行したIDを返却します。 ※同一オーダーIDでも決済手段が異なると、異なった「取引ID」および「取引パスワード」が返却されます。
AccessPass		accessPass		必須半角英数32桁固定取引パスワード発行したパスワードを返却します。 ※同一オーダーIDでも決済手段が異なると、異なった「取引ID」および「取引パスワード」が返却されます。

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813"
}

レスポンスパラメータ：正常系

AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813

レスポンスパラメータ：異常系

{
    "errCode":"E01",
    "errInfo":"E01040001"
}

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

ExecTranEpospay 決済実行

これ以降の決済取引で必要となるトークンを返却します。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
AccessID	accessID	必須半角英数32桁固定取引ID 【取引登録】で発行された値を設定します。
AccessPass	accessPass	必須半角英数32桁固定取引パスワード【取引登録】で発行された値を設定します。
OrderID	orderID	必須半角英数記号27桁オーダーID 【取引登録】で指定した値を設定します。
ClientField1	clientField1	全半角100バイト加盟店自由項目1
ClientField2	clientField2	全半角100バイト加盟店自由項目2
ClientField3	clientField3	全半角100バイト加盟店自由項目3
RetURL	retURL	必須半角英数記号128桁決済結果戻しURL
PaymentTermSec	paymentTermSec	半角数字5桁支払開始期限秒お客様が【決済実行】から【支払手続き開始IF】を呼び出すまでの期限です。最大86,400秒（1日）呼出パラメータが空の場合、120秒で処理されます。

URL

/payment/ExecTranEpospay.json

リクエストパラメータ

{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
  "orderID": "ORDER0000001",
  "retURL": "https://example.com/receive/success"
}

URL

/payment/ExecTranEpospay.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&RetURL=https://example.com/receive/success

レスポンス

正常

AccessID	accessID	必須半角英数32桁固定取引ID 対象取引のオーダーIDを返却します。
Token	token	必須半角英数256桁トークンアクセスIDのハッシュ値を返却します。
StartURL	startURL	必須半角英数記号256桁支払手続き開始IFのURL 支払手続き開始IFのURLを返却します。
StartLimitDate	startLimitDate	必須半角数字14桁固定支払開始期限日時支払手続き開始IFの呼び出し期限を返却します。 yyyyMMddHHmmss書式

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "token": "qlxcMlmNXu+YJoAPr0zIiHoG/KrcaJJkTVUEeuYe67E3Vh427rKZBJphG0D2YhAL",
  "startURL": "https://x01.xxxxx/payment/EpospayStart.idPass",
  "startLimitDate": "20190225162711"
}

レスポンスパラメータ：正常系

AccessID=a6a6b0061347e90cdef806b39bd28705&Token=qlxcMlmNXu+YJoAPr0zIiHoG/KrcaJJkTVUEeuYe67E3Vh427rKZBJphG0D2YhAL&StartURL=https://x01.xxxxx/payment/EpospayStart.idPass&StartLimitDate=20190225162711

レスポンスパラメータ：異常系

{
    "errCode":"E01",
    "errInfo":"E01040001"
}

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

EpospayStart 支払手続き開始

エポスかんたん決済において、お客様をエポスかんたん決済ログイン画面へと遷移させる必要があります。
加盟店様はリダイレクト機能を利用して、お客様を当サービスの支払手続き開始IFに誘導してください。
当サービスは、お客様をエポスかんたん決済ログイン画面に誘導します。
※取引が特定できない場合/すでに支払いを済ませている場合/支払期限切れの場合等は、エラー画面を表示します。

※idPass版にのみ対応しています。json版には対応していません。

リクエスト

AccessID		必須半角英数32桁固定取引ID 【取引登録】で発行された値を設定します。
Token		必須半角英数記号64桁固定トークン【決済実行】で発行された値を設定します。

URL

/payment/EpospayStart.idPass

リクエストパラメータ

AccessID=647a2956d5e8306ab67e415c4d01e100&Token=oEmuCBXM2on8vjUsK0FBZ40p9Xm7CpqPFQPT1uXcXbiwBS7yYvxSiC0zeMVH+O4F

リダイレクトページサンプル


<html>
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=Windows-31J">
  </head>
  <body OnLoad='OnLoadEvent();'>
    <form name="EpospayStartCall" action="{決済実行のレスポンスで返却した接続先URL}" method="POST">
    <noscript>
      <center>
        <h2>エポスかんたん決済の決済画面へ遷移します。</h2>
        <input type="submit" value="続行">
      </center>
      </noscript>
      <input type="hidden" name="AccessID" value="{AccessID}">
      <input type="hidden" name="Token" value="{Token}">
    </form>
    <script >
    <!--
      function OnLoadEvent() {
        document.EpospayStartCall.submit();
      }
    //-->
    </script>
  </body>
</html>

リダイレクト後、エポスかんたん決済ログイン画面を表示します。
エポスNet ID,パスワードを入力しログインします。

図エポスかんたん決済　ログイン画面

クーポンやエポスポイント利用、クレジットのお支払い方法を選択し、
「お支払内容の確認へ進む」をクリックすると、お支払内容の確認画面へ遷移します。
「ご利用サイトへ戻る」をクリックすると対象取引は決済不成立となります。
やり直す場合は別オーダーIDで再度【取引登録】から行ってください。

図エポスかんたん決済　お支払方法の選択画面

お支払内容の確認画面で「この内容で支払う」をクリックすると決済を行い、加盟店様のサイトへ戻ります。
「内容を変更する」をクリックすると、お支払い方法の選択画面に戻ります。

図エポスかんたん決済　お支払内容の確認画面

※「この内容で支払う」をクリック後、通信環境が悪い際等には以下の画像が表示されます。

図エポスかんたん決済　処理中画面

EpospayRsltRcv 決済結果受信

当サービスは、お客様が支払操作を完了または中止した際に決済実行時に指定された決済結果戻しURLに結果を通知します。

この決済結果は、エポスかんたん決済の決済完了画面からブラウザ経由で連携されるため、
ユーザの操作方法によっては支払操作が完了したにもかかわらず、加盟店様に通知されないことがあります。
その際はショップ管理画面または結果通知にてご確認ください。
また、同様の理由でこの決済結果が複数回加盟店様に通知されることがあります。

レスポンス

正常

ShopID	shopID	必須半角英数13桁ショップID
OrderID	orderID	必須半角英数記号27桁オーダーID
Status	status	必須現状態対象取引の取引状態を返却します。・AUTH：仮売上・PAYFAIL：決済失敗お客様が決済を完了せずにエポスかんたん決済画面から加盟店様サイトに戻った場合、「AUTHPROCESS(処理認証中)」ステータスが返却されます。
TranDate	tranDate	必須半角数字14桁固定処理日時 yyyyMMddHHmmss書式
EposTradeID	eposTradeID	必須半角英数13桁エポスかんたん決済取引ID
CheckString	checkString	必須半角英数14桁固定改ざんチェック文字列 ShopID、OrderID、Status、TranDate、EposTradeID、ShopPassを連結しMD5ハッシュした値を返却します。

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
  "shopID": "tshop11223344",
  "orderID": "ORDER0000001",
  "status": "AUTH",
  "tranDate": "20190225162711",
  "eposTradeID": "2203050003745",
  "checkString": "d3b07384d113edec49eaa6238ad5ff01"
}

レスポンスパラメータ：正常系

ShopID=tshop11223344&OrderID=ORDER0000001&Status=AUTH&TranDate=20190225162711&EposTradeID=2203050003745&CheckString=d3b07384d113edec49eaa6238ad5ff01

レスポンスパラメータ：異常系

{
    "errCode":"E01",
    "errInfo":"E01040001"
}

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

EpospaySales 実売上

仮売上の決済に対して実売上を行います。仮売上の決済の取引ID・取引パスワードを指定すると、実売上が可能です。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
AccessID	accessID	必須半角英数32桁固定取引ID 【取引登録】で発行された値を設定します。
AccessPass	accessPass	必須半角英数32桁固定取引パスワード【取引登録】で発行された値を設定します。
OrderID	orderID	必須半角英数記号27桁オーダーID
Amount	amount	必須半角数字7桁利用金額税送料を指定した場合は、利用金額 + 税送料が売上金額となります。仮売上時の金額と一致しない場合エラーとなります。
Tax	tax	半角数字7桁税送料

URL

/payment/EpospaySales.json

リクエストパラメータ

{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
  "orderID": "ORDER0000001",
  "amount": "1000"
}

URL

/payment/EpospaySales.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&Amount=1000

レスポンス

正常

OrderID	orderID	必須半角英数記号27桁オーダーID 対象取引のオーダーIDを返却します。
Status	status	必須現状態対象取引の取引状態を返却します。・SALES：実売上
Amount	amount	必須半角数字7桁利用金額実売上した利用金額を返却します。
Tax	tax	必須半角数字7桁税送料実売上したを税送料を返却します。

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
  "orderID": "ORDER0000001",
  "status": "SALES",
  "amount": "1000",
  "tax": "0"
}

レスポンスパラメータ：正常系

OrderID=ORDER0000001&Status=SALES&Amount=1000&Tax=0

レスポンスパラメータ：異常系

{
    "errCode":"E01",
    "errInfo":"E01040001"
}

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

EpospayCancel キャンセル

仮売上及び実売上取引の取引ID・取引パスワードを指定すると、以前に実施した決済内容をキャンセルすることが可能です。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
AccessID	accessID	必須半角英数32桁固定取引ID 【取引登録】で発行された値を設定します。
AccessPass	accessPass	必須半角英数32桁固定取引パスワード【取引登録】で発行された値を設定します。
OrderID	orderID	必須半角英数記号27桁オーダーID

URL

/payment/EpospayCancel.json

リクエストパラメータ

{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
  "orderID": "ORDER0000001"
}

URL

/payment/EpospayCancel.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001

レスポンス

正常

OrderID		orderID		必須半角英数記号27桁オーダーID 対象取引のオーダーIDを返却します。
Status		status		必須現状態対象取引の取引状態を返却します。・CANCEL：キャンセル

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
  "orderID": "ORDER0000001",
  "status": "CANCEL"
}

レスポンスパラメータ：正常系

OrderID=ORDER0000001&Status=CANCEL

レスポンスパラメータ：異常系

{
    "errCode":"E01",
    "errInfo":"E01040001"
}

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

EpospayChange 金額変更

仮売上及び実売上取引の取引ID・取引パスワードを指定すると、以前に実施した決済内容の金額を変更することが可能です。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
AccessID	accessID	必須半角英数32桁固定取引ID 【取引登録】で発行された値を設定します。
AccessPass	accessPass	必須半角英数32桁固定取引パスワード【取引登録】で発行された値を設定します。
OrderID	orderID	必須半角英数記号27桁オーダーID 【取引登録】で指定した値を設定します。
ChangeAmount	changeAmount	必須半角数字7桁変更後利用金額変更後の利用金額と税送料を設定します。変更後税送料を指定した場合は、変更後利用金額 + 変更後税送料が変更後金額となります。変更後利用金額は[1円～変更前の利用金額]、変更後税送料は[0円～変更前の税送料]の範囲で設定可能です。変更後利用金額と変更後税送料の合計が、変更前の合計を下回るように設定してください。
ChangeTax	changeTax	半角数字7桁変更後税送料

URL

/payment/EpospayChange.json

リクエストパラメータ

{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
  "orderID": "ORDER0000001",
  "changeAmount": "800"
}

URL

/payment/EpospayChange.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&ChangeAmount=800

レスポンス

正常

OrderID	orderID	必須半角英数記号27桁オーダーID
Status	status	必須現状態対象取引の取引状態を返却します。・AUTH：仮売上・SALES：実売上
ChangeAmount	changeAmount	必須半角数字7桁変更後利用金額変更後の利用金額を返却します。
ChangeTax	changeTax	必須半角数字7桁変更後税送料変更後の税送料を返却します。

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
  "orderID": "ORDER0000001",
  "status": "AUTH",
  "changeAmount": "800",
  "changeTax": "80"
}

レスポンスパラメータ：正常系

OrderID=ORDER0000001&Status=AUTH&ChangeAmount=800&ChangeTax=80

レスポンスパラメータ：異常系

{
    "errCode":"E01",
    "errInfo":"E01040001"
}

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

SearchTradeMulti 取引状態参照

対象取引の取引状態を取得します。

※idPass版にのみ対応しています。json版には対応していません。

リクエスト

ShopID		必須半角英数13桁ショップID
ShopPass		必須半角英数64桁ショップパスワード
OrderID		必須半角英数記号27桁オーダーID 【取引登録】で指定した値を設定します。
PayType		必須半角数字2桁決済方法 40：エポスかんたん決済

URL

/payment/SearchTradeMulti.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&PayType=40

レスポンス

正常

Status		必須現状態 UNPROCESSED：未決済 REQSUCCESS：要求成功 AUTHPROCESS：認証処理中 AUTH：仮売上 SALES：実売上 CANCEL：キャンセル PAYFAIL：決済失敗 EXPIRED：期限切れ
ProcessDate		必須半角数字14桁固定処理日時 yyyyMMddHHmmss書式
JobCd		必須処理区分 AUTH：仮売上 SALES：実売上 CANCEL：キャンセル CHANGE：金額変更 EXPIRE：期限切れ
AccessID		必須半角英数32桁固定取引ID
AccessPass		必須半角英数32桁固定取引パスワード
Amount		必須半角数字7桁利用金額
Tax		必須半角数字7桁税送料
ClientField1		必須全半角100バイト加盟店自由項目1
ClientField2		必須全半角100バイト加盟店自由項目2
ClientField3		必須全半角100バイト加盟店自由項目3
PayType		必須半角数字2桁決済方法 40：エポスかんたん決済
EposTradeID		必須半角英数13桁エポスかんたん決済取引ID
EposUseCouponAmount		必須半角数字7桁利用クーポン額お客様がエポスかんたん決済で利用したクーポン額です。
EposUsePoint		必須半角数字7桁利用エポスポイントお客様がエポスかんたん決済で利用したエポスポイントです。
TotalCancelAmount		必須半角数字7桁キャンセル金額の累積該当取引について発生したキャンセル・減額金額の累計を返却します。
TotalCancelTax		必須半角数字7桁キャンセル税送料金額の累積該当取引について発生したキャンセル・減額税送料の累計を返却します。

異常

ErrCode		半角英数3桁固定エラーコード
ErrInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

Status=AUTH&ProcessDate=20190213200436&JobCd=AUTH&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&Amount=1000&Tax=100&ClientField1=&ClientField2=&ClientField3=&PayType=40&EposTradeID=1903280000001&EposUseCouponAmount=200&EposUsePoint=50&TotalCancelAmount=10&TotalCancelTax=10

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001